set_overwrite

audio_form object

This method will set the overwrite mode of an input box.

bool set_overwrite_mode(int control_id, bool overwrite)

Parameters:
control_id
The ID of the control you wish to change.
overwrite
A boolean value indicating whether the control should have overwrite enabled or disabled.

Return value:
true on success, false on failure.

Remarks:
If overwrite is enabled, new text that is entered into the control will overwrite old highlighted text rather than adding to it.

Example:

// Make a form with a few input boxes, and change the overwrite mode with one of them.

#include "form.bgt"

audio_form form;

void main()
{
form.create_window("Example Form", true);
int edit=form.create_input_box("Edit me.");
int overwrite=form.create_input_box("Overwrite me.", "Overwrite me.");
form.set_overwrite_mode(overwrite, true);
int cancel=form.create_button("E&xit");
while(true)
{
form.monitor();
wait(5);
if(form.is_pressed(cancel))
{
exit();
}
if((key_down(KEY_LMENU))&&(key_pressed(KEY_F4)))
{
exit();
}
}
}